home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / WINWORDS / CLX22_MS.ZIP / CLXMAN.TXT < prev    next >
Text File  |  1993-04-07  |  93KB  |  2,761 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                          clX
  20.  
  21.                              The Clause Cross Referencer
  22.  
  23.  
  24.                                           by
  25.  
  26.                                    Andrew McBurnie
  27.  
  28.  
  29.                                      version 2.2,
  30.                                      March, 1993.
  31.  
  32.  
  33.                            copyright 1993, Andrew McBurnie.
  34.                                  All rights reserved.
  35.                   26 Chalder Street, Newtown, NSW, 2042, Australia.
  36.  
  37.  
  38.  
  39.                                CompuServe : 100033,2346
  40.                                UseNet: amcb@runx.oz.au
  41.  
  42.  
  43.  
  44.  
  45.  
  46.           Information in this  document is subject to change without  notice, and is not
  47.             guaranteed to be a complete description of the clX program.
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                        CONTENTS
  56.  
  57.  
  58.           What is clX?                                                    1
  59.  
  60.           Using clX                                                       5
  61.                The clX Main Menu.                                         5
  62.                Using Menu Items 1 and 2.                                  5
  63.                Viewing the clX Report.                                    6
  64.                Printing the clX Report.                                   7
  65.                clX Main Menu: Other Menu Items.                           7
  66.                Check-list of clX menu items that MUST be set up.          9
  67.                Saving the clX Option Settings.                            9
  68.  
  69.           Explanation of the clX Report.                                 11
  70.  
  71.           clX Style Options                                              13
  72.                Specify Annexure Banner.                                  13
  73.                Specify Definition Section Number.                        14
  74.                Specify Type of Quote Marks.                              14
  75.                Specify Maximum Clause Number.                            15
  76.                Specify Clause Format Used.                               16
  77.  
  78.           clX Processing Options                                         19
  79.                                                                          19
  80.                Ignore single character definitions.                      19
  81.                Ignore Uncapitalised Definitions.                         20
  82.                Set Ignore Character Option 1 & 2.
  83.                                                                          20
  84.  
  85.           clX Reporting Options                                          21
  86.                Produce Observations and Errors Only.                     21
  87.                Produce a verbose report.                                 21
  88.                Set report page width.                                    21
  89.                Set report page length.                                   22
  90.                Set printer control sequences.                            22
  91.  
  92.           Error Reporting Options                                        23
  93.  
  94.           Syntactic Issues                                               25
  95.                                                                          25
  96.                Identification of Clause Numbers.                         25
  97.                Assembly of Clause Numbers.                               25
  98.                Processing of Clause Number References.                   26
  99.                                                                          26
  100.                Processing of Document Attachments or Annexures.          26
  101.  
  102.           clX Error Messages                                             27
  103.                Software Signature Check.                                 27
  104.                Observation and Errors Report.                            28
  105.  
  106.           Copyright 1992, Andrew McBurnie
  107.  
  108.  
  109.  
  110.  
  111.  
  112.                Abnormal Termination Messages.                            29
  113.  
  114.           Technical Appendix                                             32
  115.                Installation Notes.                                       32
  116.                Operational Notes.                                        32
  117.                Processing Notes.                                         34
  118.  
  119.           INDEX                                                     page 43
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.                                             Copyright 1992, Andrew McBurnie
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.                                       Chapter 1
  173.  
  174.                                      What is clX?
  175.  
  176.  
  177.           The  Clause  Cross Referencer,  or "clX",  will  help you  in the
  178.           drafting,  negotiation  and  redrafting  of  any  document  which
  179.           contains numbered  paragraphs and internal references.   clX will
  180.           analyse your  document, identifying clause or  paragraph numbers,
  181.           and  listing references  in the  text to  these paragraphs.   The
  182.           program  will also  attempt to  identify such  serious errors  as
  183.           references to clause numbers that do not exist.
  184.  
  185.           A sample fragment from a typical report is set out below.
  186.  
  187.  
  188.  
  189.                     Clause '16.2.' has 9 references:
  190.                7.9.e.iv.   7.9.e.v       16.3        16.3.f (2)  
  191.                16.3.f.iv   16.4.         16.5.       16.6.
  192.  
  193.  
  194.  
  195.           In the above  fragment, you  are given a  list of clause  numbers
  196.           which  contain  references  to  clause   16.2.    Note  that  the
  197.           representation of clause numbers is 'normalised' so that dots are
  198.           always   used  as  subclause  separators,  replacing  parentheses
  199.           wherever they are used.  Clause 16.3(f) has two references.
  200.  
  201.           clX  will  identify  paragraph  numbers  whether  you  have  used
  202.           automatic paragraph  numbering,  or  whether  you  have  manually
  203.           entered your paragraph numbers.  All that is required is that you
  204.           have specified  the character  numbering format, or  template, to
  205.           clX using the menu options available.
  206.  
  207.           In many  drafting styles, clauses are not  labelled with complete
  208.           clause  numbers.  For example,  a clause labelled  only as "(c)",
  209.           might be part  of clause 6.2,  and therefore its  full number  is
  210.           6.2(c).  Even though  lower level paragraph numbers do  not carry
  211.           the  full  clause  number, such  as  one  like  6.2(c), clX  will
  212.           assemble the full clause number for cross reference purposes.
  213.  
  214.           The Clause Cross Referencer  will expand clause number references
  215.           so  that all  the  clauses within  the  range are  identified  as
  216.           referents.  For example, if a phrase such as "clauses 7.3 through
  217.           7.9" occurs  in some  clause 3.1,  then 3.1 will  be listed  as a
  218.           reference against 7.3, 7.4, 7.5, 7.6, 7.7, 7.8 and 7.9.
  219.  
  220.           The  clX  program  actually tries  to  follow  the  text of  your
  221.           document,  using natural  language  processing technology.   Some
  222.           techniques used by clX are more akin to the way  humans read text
  223.  
  224.                                             Copyright 1992, Andrew McBurnie
  225.  
  226.  
  227.  
  228.  
  229.  
  230.           2                                                                                                                               clX description
  231.  
  232.           than  the  usual way  computer process  text,  in that  "rules of
  233.           thumb",  or  "heuristic"  methods  are employed  to  extract  the
  234.           required information.  This is because natural language  is never
  235.           completely consistent, and judgement is required to interpret it.
  236.  
  237.           (Because  of  ambiguities  and   irregularities  in  the  English
  238.           language, and the  range of drafting styles which may  be used by
  239.           authors, the extraction of relevant data by clX is not guaranteed
  240.           to be either complete, or accurate.)
  241.  
  242.           You  control  the way  clX processes  your  documents by  using a
  243.           "control panel",  a system of  menu screen displays  which appear
  244.           when you  start the program.   Using  the control panel,  you can
  245.           specify  to  clX relevant  details  of your  drafting  style, for
  246.           example, your method of clause numbering.  You can prevent clause
  247.           sequence error messages from appearing.
  248.  
  249.           In summary,  The Clause Cross Referencer  is able to help  you in
  250.           the contract drafting, negotiation  and redrafting process in the
  251.           following ways:
  252.  
  253.           1.   by  identifying  clauses  or  definitions  that contain
  254.                references to non-existent clauses;
  255.  
  256.           2.   by  picking  out  apparent clause  sequence  errors, or
  257.                omitted clauses;
  258.  
  259.           3.   by  allowing  you to  quickly  locate  references to  a
  260.                particular clause which you wish to change.
  261.  
  262.  
  263.  
  264.           Administrative Matters.
  265.  
  266.  
  267.           You may  use clX  for a free  30 day trial  period.   During that
  268.           period,  you  are  strongly  advised to  carefully  evaluate  its
  269.           capabilities  against your  particular  drafting style.   If  you
  270.           continue  to use  clX after  the  30 day  trial  period, you  are
  271.           required to  obtain a license.   The licence fee is  based on $US
  272.           125  per user, with volume  discounts.  Licence  details and fees
  273.           may  be found  in  the accompanying  file,  "CLXREGIS.TXT".   The
  274.           contents of  that file  are also reproduced  at the  end of  this
  275.           manual.  The licensor of clX is Generic Software Pty Ltd (ACN 054
  276.           834 196), a proprietary company registered in Australia.
  277.  
  278.           Send discettes containing problem  documents to the address given
  279.           at the front of this manual.
  280.  
  281.  
  282.  
  283.           Copyright 1992, Andrew McBurnie
  284.  
  285.  
  286.  
  287.  
  288.  
  289.           clX description                                                   3
  290.  
  291.           For Lawyers: 
  292.  
  293.           For lawyers,  a  new  program  called, "cX,  the  Contract  Cross
  294.           Referencer", is now available.   cX offers all the  facilities of
  295.           clX, plus  the ability  to cross reference  contract definitions,
  296.           and also  to cross  reference contract annexures  or attachments.
  297.           It produces three cross reference reports:   one for definitions,
  298.           one for clauses and one for annexures/attachments.
  299.  
  300.           cX is  not  distributed as  shareware.   It  is  available for  a
  301.           license fee based on $US220  per user, from the address  given at
  302.           the  front of this manual.  Refer  to the file "CXADVERT.TXT" for
  303.           further information and volume discount information.  
  304.  
  305.           clX users may upgrade to cX by paying the difference  between the
  306.           clX price and the cX price, for the appropriate number of users.
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.                                             Copyright 1992, Andrew McBurnie
  343.  
  344.  
  345.  
  346.  
  347.  
  348.           4                                                                                                                               clX description
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.           Copyright 1992, Andrew McBurnie
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.                                      Chapter Two
  411.  
  412.                                       Using clX
  413.  
  414.  
  415.           Introduction.
  416.  
  417.           This chapter  tells you what you  need to know to be  able to run
  418.           clX under normal circumstances, with no special settings.
  419.  
  420.           The  following chapters explain further clX  options which may be
  421.           used to control reporting and cross referencing.
  422.  
  423.           Your systems  administrator will have installed  the clX software
  424.           for   you  according   to  your  local   installation  standards.
  425.           Technical instructions  about the installation of clX  are in the
  426.           "Technical Appendix" section at the end of this manual.
  427.  
  428.           The clX Main Menu.
  429.  
  430.           To begin  a session with clX, simply type the command, 'CLX', and
  431.           tap the 'return' or 'enter' key.  
  432.  
  433.           Following  display  of  the  clX logo,  copyright  and  licensing
  434.           information, (during which various  set up procedures occur), the
  435.           main clX menu will be displayed:
  436.  
  437.  
  438.                   1.  Specify document for cross referencing
  439.                   2.  Start Cross Referencing
  440.  
  441.                   3.  Set Drafting Style Options
  442.                   4.  Set Processing Options
  443.                   5.  Set Reporting Options
  444.                   6.  Set Error Detection Options
  445.                   _____________________________________________
  446.                   Press 'Esc' or 'q' to QUIT clX,
  447.                   or select one of the above
  448.                   options by typing its number:
  449.  
  450.  
  451.  
  452.           Using Menu Items 1 and 2.
  453.  
  454.           Items 1 and 2 on this menu are the ones you will use most often. 
  455.  
  456.           On selecting  item 1, the clX  main menu will be  replaced with a
  457.           message requesting  you to type in the name of the document to be
  458.  
  459.  
  460.                                             Copyright 1992, Andrew McBurnie
  461.  
  462.  
  463.  
  464.  
  465.  
  466.           6                                                                                                                                          Using clX
  467.  
  468.           processed -  that is, the PC DOS name under which the document is
  469.           stored.  
  470.  
  471.           If the document to be processed is not in the  current directory,
  472.           you must type in a full PC DOS path name.
  473.  
  474.           clX  will first check that  the document specified  can be found,
  475.           and will  then give you the  name of the listing  file into which
  476.           the cross reference report will be written.  This  file will have
  477.           the same name as the one you entered, but with the suffix ".LST".
  478.  
  479.           If you specified a  document in another directory, (that  is, you
  480.           typed    a   path    name    something    like,   for    example,
  481.           "\banking\overseas\binvest.doc"),  then the  report file  will be
  482.           placed back in that directory.
  483.  
  484.           If you do not  agree with proposed name (and  directory location)
  485.           for  the report  file,  you  may  edit  the  output  report  name
  486.           yourself.   clX will  give a warning  message if the  name of the
  487.           report file which you enter conflicts with an existing file.  clX
  488.           won't let you enter a report file  name which is the same as  the
  489.           document you specified for cross referencing.
  490.  
  491.           After you  have specified the name  of the file to  be processed,
  492.           the main menu will appear  again.  You will now see  the document
  493.           name that you entered displayed against menu item 2.  For example
  494.           if you specified the document name, "binvest.doc", then menu item
  495.           2 will read, 'Start Cross Referencing binvest.doc'.
  496.  
  497.           If you  change your  mind at  this point, and  wish to  specify a
  498.           different  document for  processing,  simply select  menu item  1
  499.           again.  Otherwise you  can now select  menu item 2, "Start  Cross
  500.           Referencing ...", for processing to begin.
  501.  
  502.           If you  select menu item 2  without having entered the  name of a
  503.           document for processing, an error message will appear.
  504.  
  505.           While cross referencing is proceeding, the  menu will be replaced
  506.           by a  display showing the  current reference  and referent  being
  507.           processed, and the amount of memory remaining.
  508.  
  509.           If, while  cross referencing is  proceeding, you decide  that you
  510.           wish to halt processing, you should be able to accomplish this by
  511.           simultaneously  pressing  the  'control'  and 'c'  keys,  or  the
  512.           'control' and 'break' keys.  On many keyboards, the 'control' key
  513.           is labelled, "Ctrl".
  514.  
  515.           Viewing the clX Report.
  516.  
  517.  
  518.  
  519.           Copyright 1992, Andrew McBurnie
  520.  
  521.  
  522.  
  523.  
  524.  
  525.           Using clX                                                        7
  526.  
  527.           When cross  referencing is  completed, the "REPORT  VIEWING" menu
  528.           will appear, shown below.  If you select item 1 on this menu, the
  529.           clX report will be displayed on the screen for you to browse.  
  530.  
  531.  
  532.                   1.  Browse Report
  533.                   2.  Print Report
  534.                   _____________________________________________
  535.                   Press 'Esc' or 'q' to QUIT clX,
  536.                   or select one of the above
  537.                   options by typing its number:
  538.  
  539.  
  540.           For browsing, use the Page  Down, Page Up and up/down arrow  keys
  541.           to scroll through the clX report listing.  
  542.  
  543.           The 'Home' key will always take you to the top of the report.
  544.  
  545.           The  'End' key  will  cause the  report  to be  scrolled  rapidly
  546.           forward;  just  tap any key to  halt it.  This  is just a way  of
  547.           moving quickly through the report.
  548.  
  549.           As with the menus, the 'Esc' or  'q' key will return you from the
  550.           clX browser to the clX menu system.
  551.  
  552.           The clX  browser contains its own help  screen.  This help screen
  553.           will appear  any time  you tap  a key that  the browser  does not
  554.           recognise.
  555.  
  556.           Printing the clX Report.
  557.  
  558.           The  "REPORT  VIEWING"  Menu item  2  will  print  the clX  cross
  559.           reference report.
  560.  
  561.           Your systems  administrator will have arranged for  the report to
  562.           be directed to the appropriate printer.
  563.  
  564.           clX Main Menu: Other Menu Items.
  565.  
  566.           The remaining items on the menu are used to set up the normal way
  567.           clX is to be used in your organisation, by specifying elements of
  568.           your drafting style,  and the way in which clX  is to process and
  569.           report upon your documents.  
  570.  
  571.           You may also wish  to make temporary changes  to your normal  clX
  572.           setup.    For example,  you may  want  to temporarily  change the
  573.           reporting  options to  produce  only an  errors and  observations
  574.           report.
  575.  
  576.           Subsequent chapters explain these menu items in more detail.
  577.  
  578.                                             Copyright 1992, Andrew McBurnie
  579.  
  580.  
  581.  
  582.  
  583.  
  584.           8                                                                                                                                          Using clX
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.           Copyright 1992, Andrew McBurnie
  638.  
  639.  
  640.  
  641.  
  642.  
  643.           Using clX                                                        9
  644.  
  645.  
  646.           Check-list of clX menu items that MUST be set up.
  647.  
  648.           The following  parameters, from the Drafting  Style Options menu,
  649.           must  be set to values  appropriate to your  documents before clX
  650.           will produce useful results.
  651.  
  652.                Annexure Banner.  
  653.  
  654.                Type of Quote Marks.
  655.  
  656.                Maximum Clause Number.
  657.  
  658.                Clause Format used.   (absolutely vital)
  659.  
  660.           For  explanations of all the  above, refer to  the details of the
  661.           "Style Options" menu in Chapter 4.  
  662.  
  663.           Also, if  your documents have  special markup characters  such as
  664.           asterisks or hash signs, refer in Chapter 5 to the explanation of
  665.           two available set up options which instruct clX to ignore certain
  666.           characters  in your  documents.   Your mark  ups may  prevent clX
  667.           correctly  identifying  some  clause  numbers.    This  sometimes
  668.           happens  with  unspecialised  precedent  documents,  or  template
  669.           documents.  (However, a basic assumption behind clX is that it is
  670.           to  be  used to  process  'normal' documents,  not  precedent, or
  671.           template  text,  which  may have  contain  all  kinds  of strange
  672.           formats and characters, and numbered annotations or  instructions
  673.           which will also look like clause numbers.)
  674.  
  675.           Saving the clX Option Settings.
  676.  
  677.           The options  you set up for  controlling clX are  only saved when
  678.           you actually process  a document,  that is, select  the clX  main
  679.           menu  option number  2, 'Start  Cross Referencing'.   Thereafter,
  680.           they will appear as the default settings every  time you start up
  681.           clX.  
  682.  
  683.           If,  however, you  change  some clX  options  and then  quit  clX
  684.           without  actually  performing  a  cross  reference,  your  option
  685.           settings  will  not be  saved, and  will  revert to  the original
  686.           settings the next time you start up clX.
  687.  
  688.           Special Notes.
  689.  
  690.           clX makes  use of a special  parameter file which will  appear in
  691.           your   work   area,  or   directory.     This   file   is  called
  692.           "clx$$$$$.pam",  and should  not  be deleted.    It contains  the
  693.           options needed to run clX according to your requirements.
  694.  
  695.  
  696.                                             Copyright 1992, Andrew McBurnie
  697.  
  698.  
  699.  
  700.  
  701.  
  702.           10                                                                                                                                         Using clX
  703.  
  704.           One  of  the areas  controlled by  the  clx$$$$$.pam file  is the
  705.           format of the  clauses used in your documents.   Because clX does
  706.           not assume any defaults  in this area, specification of  a clause
  707.           format is a required item.  
  708.  
  709.           If a clause format has not been set up, clX will decline to begin
  710.           cross  referencing.   You  need to  select item  5  on the  Style
  711.           Options  menu to  be able  to proceed.  This  topic is covered in
  712.           more detail in chapter four.
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.  
  731.  
  732.  
  733.  
  734.  
  735.  
  736.  
  737.  
  738.  
  739.  
  740.  
  741.  
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.           Copyright 1992, Andrew McBurnie
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.                                     Chapter Three
  765.  
  766.                             Explanation of the clX Report.
  767.  
  768.           Introduction.
  769.  
  770.           This chapter explains the report produced by clX.  
  771.  
  772.           First, a word of caution.  We  are certain that clX is a valuable
  773.           tool  that  will  perform  the  essentially  low  level  clerical
  774.           exercise  of  cross  referencing  more  quickly, efficiently  and
  775.           accurately than a human being can.  But the English language is a
  776.           baroque medium, and drafting styles are incredibly varied.  
  777.  
  778.           It is  therefore  likely that  there will  always be  syntactical
  779.           forms which clX has not come across.  You should  not assume that
  780.           the report will always contain all the references and errors that
  781.           exist  in a  document.   (License  purchasers  receive 12  months
  782.           support,  during  which  omissions  may  be able  to  be  fixed.)
  783.           Ultimately,  the clX  report complements  your own  expertise and
  784.           knowledge of your text;  it do not replace it.
  785.  
  786.           The clX Report.
  787.  
  788.           A clX report contains two sections:
  789.  
  790.           - an Observations  and Errors  section.  This  contains notes  on
  791.           apparent clause  sequence errors  and references  to non-existent
  792.           targets.  
  793.  
  794.           -  A  Clauses  Cross Reference.    For each  clause  and  all its
  795.           subclauses,  all  other  clauses  and definitions  which  can  be
  796.           identified as referring to that clause are listed.
  797.  
  798.  
  799.           Each item in  a cross  reference section starts  with the  clause
  800.           number being  cross referenced,  followed by all  the references.
  801.           (Refer to the example in Chapter 1.)
  802.  
  803.           Any  reference to  "clause 0"  in the  report actually  refers to
  804.           anything  that occurs before clause 1.  This means material right
  805.           at  the  start  of the  document  - for  contracts,  the  list of
  806.           parties, recitals and so on.
  807.  
  808.           For those drafting legal  documents, note that if you  number the
  809.           parties to an agreement at the beginning of a document, or number
  810.           the statements under a "Recitals" or "Whereas" heading,  clX will
  811.           treat  these numbered items as  clause numbers if  they match the
  812.           clause format you have  selected for processing.  This  may cause
  813.  
  814.                                             Copyright 1992, Andrew McBurnie
  815.  
  816.  
  817.  
  818.  
  819.  
  820.           12                                                   The clX Report
  821.  
  822.           some confusion  with the  'identical' clause numbers  that appear
  823.           later.
  824.  
  825.           If you  see the name  of a  definition in a  list of  references,
  826.           instead  of  a clause  number, this  means  that a  clause number
  827.           reference is to be found in the body of the definition text.   If
  828.           you  had subsidiary clause numbers in the text of the definition,
  829.           these  will be appended to the definition title appearing in your
  830.           clX  report, appearing following a '#'  mark.  This will serve to
  831.           more  accurately  locate references  in  the  text of  a  lengthy
  832.           definition.
  833.  
  834.           A  number in  parentheses after  a reference  is a  count of  the
  835.           number of times a reference occurred.
  836.  
  837.           A  number following  an '@'  sign on a  reference means  that the
  838.           reference occurs in the indicated attachment, or annexure.  Refer
  839.           back to the  Observations and Errors section, and you  will see a
  840.           message   indicating  the  particular   contract  attachment,  or
  841.           annexure, which clX has  assigned to the number that  follows the
  842.           '@' symbol.
  843.  
  844.           The  phrase  '[no clause]'  used in  a  reference means  that the
  845.           reference  occurred at  a  location where  there  was no  current
  846.           clause  number.    This  often  happens  in annexures,  and  will
  847.           therefore  usually   be   associated  with   an  '@'   indicator.
  848.           References  to clause 0, mentioned  above, are a  special case of
  849.           '[no clause]'.
  850.  
  851.           An  asterisk, '*',  in  front of  a  reference signals  that  the
  852.           reference occurred in  the definition section of a  contract, but
  853.           there was  no current  definition text.   The definition  section
  854.           number  is  usually  substituted.    This  sometimes  happens  in
  855.           attachments to a  contract, when  a clause number  is used  which
  856.           happens  to  be  the  same  clause number  as  is  used  for  the
  857.           definitions section in the main document.
  858.  
  859.           The  following are  examples of  the more  complicated references
  860.           which could occur:
  861.  
  862.                5.1@2 (4) -- Four references by clause 5.1 in annexure 2.
  863.  
  864.                *[no clause]@2 (3) - There are three  references in annexure
  865.                2, they should have  been in a definition, but  weren't, and
  866.                there wasn't a clause number either ... which all means that
  867.                annexure 2 contains text but only one clause number.
  868.  
  869.  
  870.  
  871.  
  872.  
  873.           Copyright 1992, Andrew McBurnie
  874.  
  875.  
  876.  
  877.  
  878.  
  879.                                      Chapter Four
  880.  
  881.                                   clX Style Options
  882.  
  883.           Introduction.
  884.  
  885.           This chapter explains  how to specify  elements of your  drafting
  886.           style for clX.   The menu described is reached via  item 3 of the
  887.           clX main menu.
  888.  
  889.           On selection of the  Style Options menu, the following  menu will
  890.           appear:
  891.  
  892.                   1.  Specify Annexure Banner(s).
  893.                   2.  Specify Definition Section Number.
  894.                   3.  Specify Type of Quote marks.
  895.                   4.  Specify Maximum Clause Number.
  896.                   5.  Specify Clause format used.
  897.                   ______________________________________________
  898.                   Press 'Esc' or 'q' to return to the Main Menu,
  899.                   or select one of the above
  900.                   options by typing its number:
  901.  
  902.           On  the Style  Options menu  as  actually displayed,  the current
  903.           settings for  each option  will be  displayed against each  line.
  904.           These will either be  options which you have chosen,  or defaults
  905.           which were saved from the previous cross referencing session.
  906.  
  907.           Specify Annexure Banner.
  908.  
  909.           On selecting this item, a menu will be displayed which allows you
  910.           to enter  the names of  up to two  types of contract  annexure or
  911.           attachment, eg, "Schedule", "Exhibit", "Annexure" are examples of
  912.           attachments headings which you might need to specify here.
  913.  
  914.           An annexure or attachments banner is used to specify the name you
  915.           apply  to  attachments  or  annexures  in  the  document  to   be
  916.           processed.    For  example,   if  your  attachments  are  headed,
  917.           "SCHEDULE A",  "SCHEDULE B", and so on,  then the name you should
  918.           enter  for  this  option  would  be  'SCHEDULE'.    This  is  the
  919.           'attachment banner' in this instance. 
  920.  
  921.           clX looks for  attachments like "SCHEDULE  A" immediately at  the
  922.           start of a new paragraph - whether it is centred or  not does not
  923.           matter.  Upper or lower case banners will be accepted.
  924.  
  925.           If you have attachments/annexures  at the end of a  document, and
  926.           clX  does not  detect them,  perhaps due  to an  incorrect banner
  927.           specification, any  clause  number references  they contain  will
  928.           still  be  identified  and   cross  referenced.    However,  this
  929.           information  will not be distinguished  from that of  the body of
  930.           the document.  For example, a reference, say, to clause 4.3 which
  931.  
  932.                                             Copyright 1992, Andrew McBurnie
  933.  
  934.  
  935.  
  936.  
  937.  
  938.           14                                                 clX Style Options
  939.  
  940.           appears in clause 1 of  an attachment will just be reported  as a
  941.           reference by clause 1, not "clause 1@2".
  942.  
  943.           Note that if  you use a  layout style for annexure  headings that
  944.           spaces out the letters, then clX will be unable to pick them out.
  945.           For example, a heading like "A  N  N  E  X  U  R  E"  will not be
  946.           correctly identified.  Only "ANNEXURE" will be seen by clX.
  947.  
  948.           Specify Definition Section Number.
  949.  
  950.           This item is probably only applicable if you are drafting a legal
  951.           contract.  
  952.  
  953.           On selecting this item, a message will be displayed asking you to
  954.           type in a particular clause number.  Use this item to specify the
  955.           clause  number of  the  section that  contains your  interpretive
  956.           provisions, or definitions.  
  957.  
  958.           What you enter here should be a number which is the top level  of
  959.           your clause  formatting sequence.   For example,  in 2.1(a)(iii),
  960.           the  top level number is '2'.   You should not  type in '2.1', or
  961.           '2.1(a)', etc.
  962.  
  963.           The main  use of  this entry is  to allow  clX to produce  a more
  964.           helpful  cross  reference  report.   References  found  inside  a
  965.           section nominated as  the definitions section  will cause clX  to
  966.           use the title of the current definition as the reference, instead
  967.           of the current clause number.
  968.  
  969.           This  is quite important, because if  your definitions section is
  970.           large,  and  you  have  many  references  in  the  text  of  your
  971.           definitions,  you will be able to pin-point them much more easily
  972.           if  the definition  title is  used by  clX  than just  the clause
  973.           number of the definition section, (typically  clause 1).
  974.  
  975.           Specify Type of Quote Marks.
  976.  
  977.           On selecting this item, a message will be displayed asking you to
  978.           choose  the type  of quote  marks you  normally use  to delineate
  979.           definition titles.  That is, double quotes -"- or single quotes -
  980.           ` and '.
  981.  
  982.           If you process a document  in which the quote marks do  not match
  983.           the type specified by  this option, then definitions will  not be
  984.           identified.
  985.  
  986.           If  you do not  delimit the titles  of your  definitions in quote
  987.           marks, but bold or  italicise them, then, for Word  Perfect users
  988.           only,  a special  version  of clX  can  be supplied  on  request.
  989.           However, be warned, it will not perform nearly as well in picking
  990.  
  991.           Copyright 1992, Andrew McBurnie
  992.  
  993.  
  994.  
  995.  
  996.  
  997.           clX Style Options                                                 15
  998.  
  999.           out definitions.  This  is because w/p users sometimes  mark text
  1000.           for bolding or  other character attributes  in strange ways,  eg,
  1001.           the words "Force Majeur", might actually be:
  1002.  
  1003.                 [BOLD]Force M[bold][BOLD]ajeur[bold][BOLD[bold].  
  1004.  
  1005.           clX is just not clever enough to handle all possibilities in this
  1006.           area, though it will try.
  1007.  
  1008.           Specify Maximum Clause Number.
  1009.  
  1010.           On selecting this item, a message will be displayed asking you to
  1011.           type  in a particular clause  number.  Once  Clause numbers which
  1012.           are higher than the clause number you specify here are found, clX
  1013.           will  regard this  as the end  of the  document.   Clause numbers
  1014.           higher than the maximum clause number will not be recognised, and
  1015.           contract attachments will be ignored.  
  1016.  
  1017.           Again, what you enter for this option should be a number from the
  1018.           top  level of your clause  formatting sequence.   For example, in
  1019.           30.1(a)(iii), the top level number is '30'.  
  1020.  
  1021.           A  number,  that is  digits, should  always  be entered  for this
  1022.           option.
  1023.  
  1024.           In  order  for a  maximum  clause number  to  have the  effect of
  1025.           terminating a  clX pass, there  must be no  sequence errors.   In
  1026.           particular, a maximum clause number,  if detected, will only halt
  1027.           processing if it  is one  greater than  the immediately  previous
  1028.           clause number.
  1029.  
  1030.           You  may use  the maximum  clause number  option to  restrict clX
  1031.           processing to  the early part of  a document.   However, there is
  1032.           another  use which clX makes of the maximum clause number option.
  1033.           This  second use  of the  maximum clause  number option  is as  a
  1034.           simple  way of preventing clX from mistaking some types of number
  1035.           as clauses, a common example being street numbers.   
  1036.  
  1037.           The  number you  enter for  this option  should therefore  be the
  1038.           highest  clause  number  likely  to  be  used  by  most  of  your
  1039.           documents.    However,   it  is  important  that  the  number  is
  1040.           realistic, and  not set too  high.  As  suggested above,  you may
  1041.           need  to change  this option  from document  to document  in some
  1042.           circumstances.
  1043.  
  1044.           The maximum  clause number concept  refers only to  the principal
  1045.           document, not to attachments.  
  1046.  
  1047.           If you  have a table of  contents at the front  of your document,
  1048.           the maximum  clause number  option could  cause clX to  terminate
  1049.  
  1050.                                             Copyright 1992, Andrew McBurnie
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.           16                                                 clX Style Options
  1057.  
  1058.           while reading the  contents table, on the  entry that corresponds
  1059.           to  the  maximum clause  number.   Normally, however,  clX should
  1060.           detect content tables.
  1061.  
  1062.           Specify Clause Format Used.
  1063.  
  1064.           On selecting this item, a list of different clause format options
  1065.           will  be  displayed, from  which a  choice should  be made.   You
  1066.           should  choose  the   clause  formatting  option,   or  template,
  1067.           corresponding to the drafting  style that you require.   The menu
  1068.           options appear as follows:
  1069.  
  1070.                   A.    1.1(a)(i)(A)(I)
  1071.                   B.    1.1.1.1.1.1
  1072.                   C.    1(a)(i)(A)(I)
  1073.                   D.    A.1.1(a)(1)(A)
  1074.                   E.    1.1(a)(1)(A)
  1075.                   F.    1A.(1)(a1)(i)  
  1076.  
  1077.           The menu items  are labelled  'A' through to  'F' for  selection.
  1078.           The  'pseudo clauses' which appear against 'A' through 'F' in the
  1079.           list  of menu items are patterns, or templates, which describe in
  1080.           a  precise manner  a particular  clause number  formatting style.
  1081.           Each letter or  number indicates  the type of  a particular  sub-
  1082.           clause, as follows:
  1083.  
  1084.             1 - a sequence of Arabic digits, ie 0 to 9.
  1085.             a - a sequence of lower case letters, ie a to z.
  1086.             A - a sequence of upper case letters, ie A to Z.
  1087.             i - a sequence of lower case Roman numerals.
  1088.             I - a sequence of upper case Roman numerals.
  1089.  
  1090.           The  symbols used to separate a subclause appear in the patterns.
  1091.           For example in "1.1", the dot indicates that clX will look for an
  1092.           actual dot to separate the two subclauses.  In "1.1(a) ... ", the
  1093.           left and right parentheses are the symbols which  clX will use to
  1094.           separate the next subclauses, and so on. 
  1095.  
  1096.           For example,  in format  option 'A', which  is "1.1(a)(i)(A)(I)",
  1097.           clX will  recognise  clause numbers  such  as:   23.2,  11.16(a),
  1098.           5.4(c)(i), and  so on.   Further,  clX will recognise  individual
  1099.           subclauses when they appear on  separate paragraphs, and put them
  1100.           together to assemble the full clause number for cross referencing
  1101.           purposes.  
  1102.  
  1103.           If you  do not see your  particular clause format in  the options
  1104.           displayed above, please contact the author.
  1105.  
  1106.           Normally, your usual clause  format would be a saved  option, and
  1107.           you will not  have to use  this menu item.   However, should  you
  1108.  
  1109.           Copyright 1992, Andrew McBurnie
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.           clX Style Options                                                 17
  1116.  
  1117.           change  it to  process a  particular document,  perhaps one  from
  1118.           another organisation  which has  a different drafting  style, you
  1119.           should  remember  to  change  it  back  again  for   your  normal
  1120.           documents.
  1121.  
  1122.           The selection of  a clause format option that does not match that
  1123.           of  the document being processed  may cause clX  to generate many
  1124.           spurious error messages.  
  1125.  
  1126.           If you accidentally specify  a clause format that does  not match
  1127.           the clause formatting  actually used,  clX may  detect this,  and
  1128.           will halt in the early stages of processing to ask if you wish to
  1129.           continue.  The analysis  clX does to decide whether  an incorrect
  1130.           clause format  may have  been selected  is an intelligent  guess.
  1131.           There is a  possibility that clX  may not detect  that the  wrong
  1132.           format has been selected, or may halt with this query even though
  1133.           you have not made an error.
  1134.  
  1135.           Note that documents that  contain more than one method  of clause
  1136.           formatting  will  cause  clX  to produce  incomplete  and/or  odd
  1137.           results.  
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.  
  1144.  
  1145.  
  1146.  
  1147.  
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.                                             Copyright 1992, Andrew McBurnie
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.           18                                                 clX Style Options
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.  
  1218.  
  1219.  
  1220.  
  1221.  
  1222.  
  1223.  
  1224.  
  1225.  
  1226.  
  1227.           Copyright 1992, Andrew McBurnie
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.                                      Chapter Five
  1234.  
  1235.                                 clX Processing Options
  1236.  
  1237.           Introduction.
  1238.  
  1239.           This  chapter explains how to  prevent clX from becoming confused
  1240.           by markup characters,  primarily those that are  likely to appear
  1241.           directly against clause numbers, and also to fine tune the manner
  1242.           in which definitions are  used in contracts.  The  menu described
  1243.           is reached via item 4 of the clX main menu.
  1244.  
  1245.           On selection of the  Processing Options menu, the  following menu
  1246.           will appear:
  1247.  
  1248.                   1.  Ignore single character definitions.
  1249.                   2.  Ignore uncapitalised definitions.
  1250.                   3.  Set Ignore Character Option 1.
  1251.                   4.  Set Ignore Character Option 2.
  1252.                   ______________________________________________
  1253.                   Press 'Esc' or 'q' to return to the Main Menu,
  1254.                   or select one of the above
  1255.                   options by typing its number:
  1256.  
  1257.           On  the Processing Options menu  that you actually see displayed,
  1258.           the current  settings for each  option will be  displayed against
  1259.           each  line.  These  will either  be options  you have  chosen, or
  1260.           defaults  that were  saved  from the  previous cross  referencing
  1261.           session.
  1262.  
  1263.           Ignore single character definitions.
  1264.  
  1265.           This  feature allows you to fine tune the references which appear
  1266.           in the clX report for maximum relevance.  Sometimes you may  find
  1267.           that 'definitions'  such as  "A", "B"  or "X" and  "Y" are  being
  1268.           picked up  by clX.   A  single character  enclosed in quotes  may
  1269.           often be meaningless and should not be taken as definition title.
  1270.           They typically result from explanations of terms in formula.  For
  1271.           example:
  1272.  
  1273.                (X - Y) / X
  1274.  
  1275.                "X" means ...
  1276.                "Y" means ...
  1277.  
  1278.           These  may well not be true definitions, defined globally for the
  1279.           entire document,  but 'local' definitions, which  may appear more
  1280.           than once in different types  of formula scattered throughout the
  1281.           document.  The 'scope' of their meaning is confined to  that of a
  1282.           single clause or definition.
  1283.  
  1284.  
  1285.  
  1286.                                             Copyright 1992, Andrew McBurnie
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.           20                                             clX Processing Options
  1293.  
  1294.           The 'Ignore single  character...' menu option allows  you to stop
  1295.           the appearance of such entries.
  1296.  
  1297.           The default setting for this option is Yes.
  1298.  
  1299.           Ignore Uncapitalised Definitions.
  1300.  
  1301.           This  feature allows you to fine tune the references which appear
  1302.           in your clX report for maximum relevance.  
  1303.  
  1304.           The text of  a definition  titled, "The System"  could happen  to
  1305.           contain minor quoted material which should not itself  be treated
  1306.           as a definition title.  Its acceptance by clX would result in any
  1307.           references  between  it  and  the  next  definition  title  being
  1308.           ascribed to it,  and not to "The System".   This feature has been
  1309.           added for those drafting legal contracts.
  1310.  
  1311.           Set Ignore Character Option 1 & 2.
  1312.  
  1313.           Occasionally,  some documents  contain  special  characters  that
  1314.           prevent the  correct identification  of clause numbers  and other
  1315.           important syntactic components, if concatenated with them.  These
  1316.           options  give you  the chance to  tell clX  to by-pass  up to two
  1317.           particular characters before syntactic analysis.  If you specify,
  1318.           for example, that the character # is to be ignored, the effect is
  1319.           as  if  you had  used  a word  processing  program to  delete all
  1320.           occurrences of # from  the document, prior to running  it through
  1321.           clX, (although clX does not alter a document it reads).
  1322.  
  1323.           You should make  use of  this feature  if you  have used  special
  1324.           markup  characters  against clause  numbers, since  otherwise clX
  1325.           will be unable to identify them.
  1326.  
  1327.           NOTE :   you  should not  'ignore' characters  which are used  as
  1328.           delimiters in clause numbers, eg, ., (, ).  
  1329.  
  1330.           The default settings for these options are "[" and "*".
  1331.  
  1332.  
  1333.  
  1334.  
  1335.  
  1336.  
  1337.  
  1338.  
  1339.  
  1340.  
  1341.  
  1342.  
  1343.  
  1344.  
  1345.           Copyright 1992, Andrew McBurnie
  1346.  
  1347.  
  1348.  
  1349.  
  1350.  
  1351.           clX Processing Options                                             21
  1352.  
  1353.  
  1354.                                      Chapter Six
  1355.  
  1356.                                 clX Reporting Options
  1357.  
  1358.           Introduction.
  1359.  
  1360.           This  chapter  explains  how  to  control  the  way  clX produces
  1361.           reports.   The menu described  is reached via  item 5 of  the clX
  1362.           main menu.
  1363.  
  1364.           Item 5, Report Options.
  1365.  
  1366.           On selection of item 5 of the main menu, the  following menu will
  1367.           appear:
  1368.  
  1369.                   1.  Produce Observations and Errors only.
  1370.                   2.  Produce a verbose report.
  1371.                   3.  Set report page width.
  1372.                   4.  Set report page length.
  1373.                   5.  Set printer control sequences.
  1374.                   ______________________________________________
  1375.                   Press 'Esc' or 'q' to return to the Main Menu,
  1376.                   or select one of the above
  1377.                   options by typing its number:
  1378.  
  1379.  
  1380.           As it actually  appears on the screen,  the above menu  will also
  1381.           show the current settings for each item.
  1382.  
  1383.           Produce Observations and Errors Only.
  1384.  
  1385.           This option allows you  to prevent clX printing the  clause cross
  1386.           reference.    Cross  referencing  still  happens,  but  only  the
  1387.           Observations and Errors report is produced.
  1388.  
  1389.           Produce a verbose report.
  1390.  
  1391.           This option should  normally be left set as NO.   If selected, it
  1392.           will produce  a lengthy  Observations and Errors  report, listing
  1393.           every clause and definition found in the document.
  1394.  
  1395.           You  may very occasionally  need to use  this option to  see more
  1396.           clearly how clX has interpreted a document.
  1397.  
  1398.           Set report page width.
  1399.  
  1400.           Select  this option to specify  the page width  in characters for
  1401.           the clX report.
  1402.  
  1403.  
  1404.                                             Copyright 1992, Andrew McBurnie
  1405.  
  1406.  
  1407.  
  1408.  
  1409.  
  1410.           Set report page length.
  1411.  
  1412.           Select this option to specify in lines the page length of the clX
  1413.           report.
  1414.  
  1415.           Set printer control sequences.
  1416.  
  1417.           This option is used to control  the way in which your clX reports
  1418.           are printed.   It will  normally have  been set for  you by  your
  1419.           systems administrator.
  1420.  
  1421.           The option prompts to enter two lines of up to eighty  characters
  1422.           of special  text.  The first will be sent  to your printer to put
  1423.           it into an appropriate mode for printing your clX report, and the
  1424.           second to set it back to your normal mode.  
  1425.  
  1426.           One common use  of this facility would be to  set your printer to
  1427.           use non-proportional text, to  prevent distortion of the columnar
  1428.           clX report layout.
  1429.  
  1430.           Refer  to the Technical Appendix of this manual for more detailed
  1431.           instructions  on  the use  of  printer control  sequences.   This
  1432.           option is intended for technical support personnel.
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.  
  1439.  
  1440.  
  1441.  
  1442.  
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458.  
  1459.  
  1460.  
  1461.  
  1462.  
  1463.           Copyright 1992, Andrew McBurnie
  1464.  
  1465.  
  1466.  
  1467.  
  1468.  
  1469.           clX Reporting Options                                             23
  1470.  
  1471.                                     Chapter Seven
  1472.  
  1473.                                Error Reporting Options
  1474.  
  1475.           Introduction.
  1476.  
  1477.           This chapter explains how to prevent clX  reporting clause number
  1478.           sequence errors.  The  menu described is reached via menu  item 5
  1479.           of the clX main menu.
  1480.  
  1481.           Item 5, Error Reporting Options.
  1482.  
  1483.           On selection, this option will display the following:
  1484.  
  1485.                  Report clause sequence problems? [Y/N] :
  1486.  
  1487.  
  1488.  
  1489.                  Report Clause sequence errors:  Currently YES
  1490.  
  1491.  
  1492.           Normally this  option is set to "YES".  Respond "N" if you do not
  1493.           wish clause sequence errors to be reported.   
  1494.  
  1495.  
  1496.  
  1497.  
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.  
  1514.  
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520.  
  1521.  
  1522.                                             Copyright 1992, Andrew McBurnie
  1523.  
  1524.  
  1525.  
  1526.  
  1527.  
  1528.  
  1529.  
  1530.  
  1531.  
  1532.  
  1533.  
  1534.  
  1535.  
  1536.  
  1537.  
  1538.  
  1539.  
  1540.  
  1541.  
  1542.  
  1543.  
  1544.  
  1545.  
  1546.  
  1547.  
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.           Copyright 1992, Andrew McBurnie
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.                                     Chapter Eight
  1588.  
  1589.                                    Syntactic Issues
  1590.  
  1591.           Introduction.
  1592.  
  1593.           The purpose of this  chapter is to outline some  major processing
  1594.           techniques  used by  clX,  and to  indicate  some clX  processing
  1595.           limitations.
  1596.  
  1597.           Processing of Definitions.
  1598.  
  1599.           clX identifies  a definition name anywhere in a document if it is
  1600.           enclosed in quotes, and is also associated with certain syntactic
  1601.           structures that match the internal rule base of clX. 
  1602.  
  1603.           Identification of Clause Numbers.
  1604.  
  1605.           At the end of every paragraph in a document, clX will examine the
  1606.           first few characters of the next  paragraph to decide if a clause
  1607.           number is present.  
  1608.  
  1609.           Any sequence  of characters immediately  following the  end of  a
  1610.           paragraph  which, according to  the template supplied  by the clX
  1611.           control panel, is  syntactically a valid  clause number, will  be
  1612.           accepted  as  a  clause  number  unless  certain  other  adjacent
  1613.           syntactic structures suggest that it is not.  
  1614.  
  1615.           This  means that there is a possibility that some things that are
  1616.           not clause  numbers, but  happen to occur  at the beginning  of a
  1617.           paragraph, could  be identified by clX  as a clause number.   clX
  1618.           will be able to distinguish most of these cases correctly.  
  1619.  
  1620.           clX is  unable  to  distinguish numbered  lists  of  things  from
  1621.           clauses.  Eg, in the phrase,
  1622.  
  1623.                 "... shall be the aggregate of 
  1624.  
  1625.                (i) <something>, 
  1626.                (ii) <something else>."
  1627.  
  1628.           the roman  numerals are just  being used  to enumerate a  list of
  1629.           things,  not  to number  some clauses.   (This  is regarded  as a
  1630.           somewhat intractable problem.)
  1631.  
  1632.           Assembly of Clause Numbers.
  1633.  
  1634.           If you  make use of Roman  numerals in your drafting  style, note
  1635.           that the paragraph numbering sequence: ' ... (h)  ... (i)' can be
  1636.           ambiguous.  clX may interpret the '(i)' as an alphabetic 'i', not
  1637.           the Roman  numeral 'one'.  If it happens at all, this should only
  1638.           happen in references, not paragraph numbers.
  1639.  
  1640.                                             Copyright 1992, Andrew McBurnie
  1641.  
  1642.  
  1643.  
  1644.  
  1645.  
  1646.           26                                                  Syntactic Issues
  1647.  
  1648.           Similar  comments apply to the clause number sequences, ' ... (k)
  1649.           ... (l)' and '... (u) ... (v)'
  1650.  
  1651.           This could result in some erroneous non-existent clause reference
  1652.           messages.
  1653.  
  1654.           Processing of Clause Number References.
  1655.  
  1656.           Multiple letter subclause numbers:
  1657.  
  1658.           Multiple letters in  subclause numbers, such  as (aa), (ab),  are
  1659.           supported, but  may  generate erroneous  clause  sequence  number
  1660.           error messages. 
  1661.  
  1662.           Roman Numerals:
  1663.  
  1664.           Only  roman  numerals up  to 99  are  supported in  clause number
  1665.           references.  
  1666.  
  1667.           A limitation on the Detection of Clause Reference Errors:
  1668.  
  1669.           Although  clX  can  normally detect  references  to  non-existent
  1670.           clauses, it cannot  detect references to incorrect clauses.  That
  1671.           is,  clX is  unable to  see  that a  reference to  a clause  that
  1672.           actually exists is really a  reference to the wrong clause -  ie,
  1673.           the reference does not make any logical sense.
  1674.  
  1675.           Processing of Document Attachments or Annexures.
  1676.  
  1677.           In clX, the presence  of an attachment is tested  for immediately
  1678.           following the  end of a paragraph,  just as is the  presence of a
  1679.           new clause number. 
  1680.  
  1681.           If an attachment is to be recognised, it must have a banner which
  1682.           matches  the  option selected  from the  clX  menu system.   (For
  1683.           example, in  "Schedule B", the  banner is the  word, 'Schedule'.)
  1684.           The  attachment name itself, that  is the title  that follows the
  1685.           attachment banner, is expected to be a single word.  
  1686.  
  1687.           Any attachments found will  be displayed in a comment  message in
  1688.           the Observations and Errors Report, assigning to each a reference
  1689.           number to   be used in the cross reference  report.  For example,
  1690.           references  contained  in ANNEXURE  "A",  will  appear with  '@1'
  1691.           against them.
  1692.  
  1693.  
  1694.  
  1695.  
  1696.  
  1697.  
  1698.  
  1699.           Copyright 1992, Andrew McBurnie
  1700.  
  1701.  
  1702.  
  1703.  
  1704.  
  1705.                                      Chapter Nine
  1706.  
  1707.                                   clX Error Messages
  1708.  
  1709.           Introduction.
  1710.  
  1711.           The purpose of this chapter is to explain the meaning of selected
  1712.           messages, whose origin may  lie in an operational issue  or semi-
  1713.           technical problem.  This chapter does not contain a complete list
  1714.           of all the clX messages.
  1715.  
  1716.           If error messages are produced that do not appear to be  correct,
  1717.           registered users may send details to the Author, attaching a copy
  1718.           of the document which clX has apparently failed to process, for a
  1719.           period of twelve months from the date of license payment receipt.
  1720.           All documents  must be supplied  on diskette, not just in printed
  1721.           form.  The English language is infinite, and computers are finite
  1722.           devices.   There is no  guarantee that the  problem can be fixed,
  1723.           but reasonable efforts will be made to address the problem.  
  1724.  
  1725.           Many  of  the messages  described  below  have several  different
  1726.           forms.    The descriptions  show these  variants in  a particular
  1727.           notation which uses text enclosed in angle brackets, for example,
  1728.           <clause number>,  and  text enclosed  in  braces, for  example  {
  1729.           <clause number> | <definition> }.
  1730.  
  1731.           Something like <clause number> should be read to mean that in the
  1732.           actual message which appears on the clX report, the <  ... > will
  1733.           be replaced by a real clause number.
  1734.  
  1735.           Something like, {  <clause number> |  <definition> }, means  that
  1736.           two alternatives may  actually appear  in the message.   In  this
  1737.           example, there may be either a <clause number> or a <definition>,
  1738.           but not both.  The | symbol separates the alternatives.
  1739.  
  1740.           Software Signature Check.
  1741.  
  1742.           On opening a w/p  document for processing, clX first  checks that
  1743.           the  w/p  software manufacturer's  signature  information in  the
  1744.           header matches the type of document for which it is configured to
  1745.           process.   Warning  notes  may appear  at  the beginning  of  the
  1746.           Observations and Errors report if the version number is wrong.  
  1747.  
  1748.           For the 2.2 Word Perfect version of clX, these messages are:
  1749.  
  1750.                "*** Warning, specified file contains an internal code which
  1751.                indicates  that one  of  Word Perfect's  other products  has
  1752.                created it - it may not be a w/p file."
  1753.  
  1754.                "***  Warning,  specified  file  was  not  created  by  Word
  1755.                Perfect, version 5.1 or 5.2"
  1756.  
  1757.  
  1758.                                             Copyright 1992, Andrew McBurnie
  1759.  
  1760.  
  1761.  
  1762.  
  1763.  
  1764.           28                                                clX Error Messages
  1765.  
  1766.           If the correct signature information cannot be found at all, then
  1767.           clX will decline to process the  document, and return to the main
  1768.           menu to display the following message:
  1769.  
  1770.                "Not a Word Perfect version 5.'n' document"
  1771.  
  1772.                                  or
  1773.  
  1774.                "Not a recognised MS Word document"
  1775.  
  1776.           Observation and Errors Report.
  1777.  
  1778.           This section explains the main error messages which may appear in
  1779.           the Observations and Errors report:
  1780.  
  1781.                " *** ERROR: {  <clause number> | <definition> }  contains a
  1782.                reference to a  non-existent clause  - <non-existent  clause
  1783.                number>."
  1784.  
  1785.           This message warns you that a reference appears to have been made
  1786.           to a  clause number in the  text of the document,  but the clause
  1787.           number cannot be found in the document.
  1788.  
  1789.           If this message appears, but you  think it is wrong, refer to the
  1790.           section headed  'Processing of  Clause Number References'  in the
  1791.           Chapter on "Syntactic Issues", where you may find some indication
  1792.           of the reasons for its appearance.  
  1793.  
  1794.           This non-existent clause  number message may  be followed by  the
  1795.           qualifying statement, "( *** Above may be a reference to a clause
  1796.           in another document.")
  1797.  
  1798.  
  1799.  
  1800.                " *** ERROR: {  <clause number> | <definition> }  contains a
  1801.                reference to a non-existent clause  at the top of a range  -
  1802.                <non-existent clause number>"
  1803.  
  1804.           This is the same type of error as described previously.  The only
  1805.           difference is  that it has been  found in a phrase  such as, "...
  1806.           clauses  3.6 through 3.9...", and means that clause 3.9 could not
  1807.           be found.
  1808.  
  1809.  
  1810.  
  1811.                "{  <clause number>  | <definition>  } ***  lower and  upper
  1812.                clause references are equal - <low clause>, <high clause>."
  1813.  
  1814.  
  1815.  
  1816.  
  1817.           Copyright 1992, Andrew McBurnie
  1818.  
  1819.  
  1820.  
  1821.  
  1822.  
  1823.           clX Error Messages                                                29
  1824.  
  1825.           This  error message  warns you  that in  a phrase  such  as, "...
  1826.           clauses 3.6 through  3.6 ..." the low clause and  the high clause
  1827.           are the same.
  1828.  
  1829.  
  1830.  
  1831.                "{ <clause  number>  | <definition>  } ***  upper clause  of
  1832.                range is less than lower - <low clause>, <high clause>"
  1833.  
  1834.           This  error message  warns you  that  in a  phrase such  as, "...
  1835.           clauses  3.6(c) through 3.6(a) ...", the high clause is less than
  1836.           the low clause.
  1837.  
  1838.  
  1839.  
  1840.                "***  Invalid  clause  reference  at "{  <clause  number>  |
  1841.                <definition> }" 
  1842.  
  1843.           This error message warns you that a  clause reference in the body
  1844.           of  your text did not match  the clause format template which you
  1845.           specified using the Style Options menu.
  1846.  
  1847.  
  1848.  
  1849.                "**** Pass 2, RefLst is full - "
  1850.                " *** <clause number> - is too long"
  1851.  
  1852.           The number of characters being assembled into a clause number was
  1853.           so  many  that an  internal storage  array was  insufficient, and
  1854.           processing of the clause was abandoned.
  1855.  
  1856.  
  1857.  
  1858.                "**** CRASH - too  may subclauses in a list of references at
  1859.                clause <clause number>"
  1860.  
  1861.           This  error message occurs when  an internal limit  within clX is
  1862.           exceeded.  It means that a list of subclause references was being
  1863.           processed, eg,  something like, "clauses  (a), (b), (c)  ... etc"
  1864.           and that there were too many subclauses in this list.  Currently,
  1865.           this internal limit is set to fifty.
  1866.  
  1867.           Abnormal Termination Messages.
  1868.  
  1869.           The following  messages appear only when something has gone badly
  1870.           wrong inside the clX program.  
  1871.  
  1872.  
  1873.                " ***  ... came to default case in parser"
  1874.  
  1875.  
  1876.                                             Copyright 1992, Andrew McBurnie
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.           30                                                clX Error Messages
  1883.  
  1884.           Refer the above message to the Author.
  1885.  
  1886.  
  1887.                "clXfinishStatus() called with null message"
  1888.  
  1889.           Refer this message to the Author.
  1890.  
  1891.  
  1892.  
  1893.                "can't find control panel"
  1894.  
  1895.           clX  was unable  to  open the  clx$$$$$.pam"  file.   Refer  this
  1896.           message to your systems administrator.
  1897.  
  1898.  
  1899.  
  1900.                "unexpected EOF while looking for parameter banner"
  1901.                "unexpected EOF while reading clause format specifier"
  1902.                "unexpected EOF while reading QuoteType"
  1903.                "unexpected EOF while reading switch"
  1904.                "invalid clause format specifier"
  1905.                "level too high in clause format specifier"
  1906.                "invalid subclause type specifier"
  1907.                "invalid RNULLAllowed switch"
  1908.                "invalid definition section specifier"
  1909.                "invalid Quote Type specifier"
  1910.  
  1911.           All the above mean  either that the clx$$$$$.pam file  has become
  1912.           corrupted, or that clX itself has been incorrectly configured.
  1913.  
  1914.  
  1915.  
  1916.                "No input file specified"
  1917.                "No output file specified"
  1918.                "Output file has same name as input"
  1919.                "can't create clX listing file"
  1920.                "too many parameters"
  1921.                "clX control panel load failed"
  1922.                "**failed to write control panel!**"
  1923.                "** can't find clXback executable **"
  1924.                "clX config problem... rule base image lost"
  1925.                "rulebase ... clX internal config problem"
  1926.                "clX rulebase image ..."
  1927.                " -- can't find clXfront executable"
  1928.  
  1929.           All the above will  be caused by some configuration  problem with
  1930.           clX, or just possibly running out of disk space.
  1931.  
  1932.  
  1933.  
  1934.  
  1935.           Copyright 1992, Andrew McBurnie
  1936.  
  1937.  
  1938.  
  1939.  
  1940.  
  1941.           clX Error Messages                                                31
  1942.  
  1943.                "no <board name> driver"
  1944.                "no <font name>"
  1945.                "no graphics"
  1946.  
  1947.           Any  of  the above  may suggest  some  hardware problem  with the
  1948.           workstation, or that clX has been incorrectly configured for you.
  1949.  
  1950.  
  1951.                "avlTree - not enough memory"
  1952.                "dynMem - not enough memory"
  1953.                "dList - not enough memory"
  1954.                "Ran out of memory"
  1955.  
  1956.           A  very large and complex document could  cause clX to run out of
  1957.           memory.   If this happens on a  large document, you could request
  1958.           your systems administrator to configure a special PC without your
  1959.           usual TSR's, network drivers, etc, to save space in  conventional
  1960.           memory.    If using  DOS  version  5,  make  sure you  take  full
  1961.           advantage of the "load High" capabilities.
  1962.  
  1963.  
  1964.           Finally,  the  following  termination messages  could  appear  if
  1965.           severe  internal processing problems occur.  They are part of the
  1966.           original debugging code for clX, and have been left enabled.  
  1967.  
  1968.                "stack overflow!"
  1969.                "dList - attempted to linkout from an empty list"
  1970.                "dList - attempted to get from empty list"
  1971.                "dList - attempted update of empty list"
  1972.                "avlTree - insert called with nullpointer"
  1973.                "avlTree - duplicate key during insert"
  1974.  
  1975.           The  possibility of  any of  these abnormal  termination messages
  1976.           occurring is remote.  
  1977.  
  1978.  
  1979.  
  1980.  
  1981.  
  1982.  
  1983.  
  1984.  
  1985.  
  1986.  
  1987.  
  1988.  
  1989.  
  1990.  
  1991.  
  1992.  
  1993.  
  1994.                                             Copyright 1992, Andrew McBurnie
  1995.  
  1996.  
  1997.  
  1998.  
  1999.  
  2000.  
  2001.                                   Technical Appendix
  2002.  
  2003.                           Installing clX; Operational Notes
  2004.  
  2005.  
  2006.           Introduction.
  2007.  
  2008.           This  appendix is intended to be used by a systems administrator.
  2009.           It  provides technical  information  about  the installation  and
  2010.           running of clX.
  2011.  
  2012.           Installation Notes.
  2013.  
  2014.           The Clause Cross Referencer  consists of four separate executable
  2015.           files, or .EXE files, which must all be copied on to your system.
  2016.           The executable  files are  clx.exe, clxovl1.exe,  clxovl2.exe and
  2017.           clxovl3.exe.   In  addition the  following text  files should  be
  2018.           present:  clxman.txt  (this   manual),  clxregis.txt   (important
  2019.           instructions  on  how  to  pay  the  author),  clxintro.txt,  and
  2020.           readme.txt, clxplans.txt, clxupd.txt.
  2021.  
  2022.           The clX program is not copy protected.  
  2023.  
  2024.           If  yours is a large computer installation, you will already have
  2025.           your  own standards  for  the location  of  software.   The  only
  2026.           requirement for clX is that  all the executable files must be  in
  2027.           the same directory, or on the same executable path.
  2028.  
  2029.           If  you are installing clX  on one or  more stand-alone machines,
  2030.           the most convenient  method of  installation may be  to create  a
  2031.           directory  called "CLX", and copy  the contents of  the clX files
  2032.           into it.   The name of  the directory which you  have created for
  2033.           clX  must  then   be  added   to  the  'path'   command  in   the
  2034.           'autoexec.bat' file of the root directory.
  2035.  
  2036.           There  are no  special set  up options  required at  the time  of
  2037.           installation.  The only task for installation is  to copy the clX
  2038.           executable files on  to your system, and  also the "clx$$$$$.pam"
  2039.           file, which should also be present.
  2040.  
  2041.           Operational Notes.
  2042.  
  2043.           The operation of  the clX  program is controlled  by a  parameter
  2044.           file called  "clx$$$$$.pam", which clX assumes  is always located
  2045.           in the current path.
  2046.  
  2047.           This clx$$$$$.pam file contains code sequences which specify such
  2048.           things as the format used for  clause sequencing, page dimensions
  2049.           for the clX  report, what type of errors are  to be detected, and
  2050.           other  items.   These  sequences are  generated  by the  clX menu
  2051.           system under the control of the user.  
  2052.  
  2053.           Copyright 1992, Andrew McBurnie
  2054.  
  2055.  
  2056.  
  2057.  
  2058.  
  2059.           Technical Appendix                                                33
  2060.  
  2061.           New control parameters set up by the user are only written out to
  2062.           the  clx$$$$$.pam file when the user selects a document for cross
  2063.           referencing, and begins cross reference processing.
  2064.  
  2065.           If  a clx$$$$$.pam file is  not present in  the current directory
  2066.           when clX is started, then one  will be created based on  standard
  2067.           internal default settings, and the user will be invited to change
  2068.           them.  In particular, the user must select a clause format style,
  2069.           as clX has no internal defaults in this area.
  2070.  
  2071.           During  normal  operation, clX  will create  a  work file  in the
  2072.           current  directory called  "clx$$ret.pam".   This will  always be
  2073.           deleted by clX itself, and should not normally be seen.  The size
  2074.           of this file will never be larger than about fifty characters.
  2075.  
  2076.           The  cross reference report is  written to a  listing file in the
  2077.           current path of the same name as the input file,  with the suffix
  2078.           ".LST", or as nominated by the user.
  2079.  
  2080.           Following production of a listing file, clX will optionally print
  2081.           it to  the standard DOS  PRN: device, or  you can print  the file
  2082.           separately  using the DOS print  command.  The  listing file will
  2083.           contain  ordinary ascii  text, with  no control  characters other
  2084.           than  LF-CR  sequences  and   form  feed  characters,  unless  as
  2085.           described in the next paragraph.
  2086.  
  2087.           Printers  which are set up for proportional fonts may distort the
  2088.           columnar layout  of the  reports.  Item  5 on the  Report Options
  2089.           menu  will  allow you  to  set up  hexadecimal  control sequences
  2090.           appropriate to your printer.  You can  set up a starting sequence
  2091.           and  a reset  sequence  which will  bracket the  text of  the clX
  2092.           report.  
  2093.  
  2094.           You must enter each  hex character in a printer  control sequence
  2095.           as  two ascii characters from the set 0-9, A-F, representing each
  2096.           of the four bits.   The two character pairs forming each  control
  2097.           sequence must be contiguous.  
  2098.  
  2099.           You  have  the  'usual'  keyboard based  editing  facilities  for
  2100.           creating  hex control strings.   For moving the  cursor: left and
  2101.           right arrow keys,  the home and  end keys.   The insert key  will
  2102.           toggle insert mode of and off.  Delete characters using backspace
  2103.           and delete.   Delete  to the end  of a  string with  Control+End.
  2104.           Delete to the start of a string with Control+Home.
  2105.  
  2106.           The 'Enter' or  'Return' key will signify the end  of the control
  2107.           sequence.  So will an up or down arrow.
  2108.  
  2109.  
  2110.  
  2111.  
  2112.                                             Copyright 1992, Andrew McBurnie
  2113.  
  2114.  
  2115.  
  2116.  
  2117.  
  2118.           34                                                Technical Appendix
  2119.  
  2120.           Processing Notes.
  2121.  
  2122.           Processing by clX is in  two phases: a first pass which  collects
  2123.           all the clauses, and a second pass which reads the document again
  2124.           to collect clause references.  The program seeks to the beginning
  2125.           of the document  to begin the second pass; it  does not close and
  2126.           reopen the document.  The second pass is slower than the first.  
  2127.  
  2128.           clX builds  its cross reference tables in memory dynamically, and
  2129.           will therefore utilise as much  conventional memory below 640K as
  2130.           is  available and  is required.   clX  does  not use  expanded or
  2131.           extended memory.
  2132.  
  2133.           The  presence of  terminate  and stay  resident programs,  device
  2134.           drivers, and  other software such  as a network  operating system
  2135.           shell, will all contribute  towards reducing the memory available
  2136.           to clX.  
  2137.  
  2138.           Note that it is possible that some DOS memory management programs
  2139.           may interfere  with the operation  of clX.  For  example QEMM 386
  2140.           from Quarterdeck may do this on a networked system.  Ensure  that
  2141.           utilities such as  QEMM are  configured not to  control areas  of
  2142.           memory  in the first megabyte  which are used  by network adaptor
  2143.           cards  or you may find that clX experiences problems, for example
  2144.           claiming  that a document  is not a Word  Perfect 5 document, and
  2145.           refusing to process it.
  2146.  
  2147.  
  2148.  
  2149.  
  2150.  
  2151.  
  2152.  
  2153.  
  2154.  
  2155.  
  2156.  
  2157.  
  2158.  
  2159.  
  2160.  
  2161.  
  2162.  
  2163.  
  2164.  
  2165.  
  2166.  
  2167.  
  2168.  
  2169.  
  2170.  
  2171.           Copyright 1992, Andrew McBurnie
  2172.  
  2173.  
  2174.  
  2175.  
  2176.  
  2177.                                                                     page 35
  2178.  
  2179.            
  2180.                     clX 2.2, The Clause Cross Referencer ("clX").
  2181.                                 (Word Perfect version)
  2182.  
  2183.                                Registration/Licensing 
  2184.  
  2185.                                    (PC DOS version)
  2186.  
  2187.           You may  use clX for a 30 day trial period, provided you abide by
  2188.           the  terms of the license  agreement.  (During  the trial period,
  2189.           you  are strongly  advised to  carefully evaluate  the Software's
  2190.           capabilities  against your  particular drafting  style.)   If you
  2191.           continue  to use  clX  after the  30 day  trial  period, you  are
  2192.           obligated to purchase a license.   
  2193.  
  2194.           Recipients of clX must be informed, in advance, that any fee paid
  2195.           to  acquire clX from a distributor does not relieve recipients of
  2196.           their  obligation to purchase a license from the licensor if they
  2197.           use  clX.    The PC  DOS  files  which  constitute  clX, must  be
  2198.           distributed together, including all associated text files (.TXT).
  2199.           clX  may  only  be  bundled  with  other  products  with  written
  2200.           permission from the Licensor.
  2201.  
  2202.           Upon payment of  the licence fee, you will receive  an up to date
  2203.           copy  of  clX,  future updates  as  they  appear,  and 12  months
  2204.           support.
  2205.  
  2206.           Please complete  the following  and read  the attached  Terms and
  2207.           Conditions.  Completion of  and signing this form  constitutes an
  2208.           agreement  to take the Software named above on License subject to
  2209.           the Terms and Conditions below.
  2210.  
  2211.           LICENSEE INFORMATION
  2212.  
  2213.           Licensee Name:     .........................................
  2214.           Licensee Contact:  .........................................
  2215.           License Telephone: ...........................
  2216.           Licensee Address:
  2217.                Street      ...........................................
  2218.                Suburb      ...........................................
  2219.                City        ...........................................
  2220.                Postcode/Zip     ............
  2221.  
  2222.           E-Mail Address(es):   ......................................
  2223.  
  2224.           Where did you  
  2225.           obtain your copy of clX ? ..................................
  2226.  
  2227.           Disk size:  5.25" / 3.5" (cross out one).
  2228.  
  2229.           clX LICENCE FEE:  $US 125.00 for one user.
  2230.           (or equivalent amount in other currencies)
  2231.  
  2232.  
  2233.  
  2234.  
  2235.  
  2236.           clX, Licensing Agreement.                         Technical Appendix                                                                    page 36
  2237.  
  2238.           Refer to the scale below for volume pricing information.
  2239.  
  2240.           Number of Users: ..... Total Price: ...... (use scale below)
  2241.  
  2242.  
  2243.  
  2244.  
  2245.  
  2246.  
  2247.  
  2248.  
  2249.  
  2250.  
  2251.  
  2252.  
  2253.  
  2254.  
  2255.  
  2256.  
  2257.  
  2258.  
  2259.  
  2260.  
  2261.  
  2262.  
  2263.  
  2264.  
  2265.  
  2266.  
  2267.  
  2268.  
  2269.  
  2270.  
  2271.  
  2272.  
  2273.  
  2274.  
  2275.  
  2276.  
  2277.  
  2278.  
  2279.  
  2280.  
  2281.  
  2282.  
  2283.  
  2284.  
  2285.  
  2286.  
  2287.  
  2288.  
  2289.           Copyright 1992, Andrew McBurnie
  2290.  
  2291.  
  2292.  
  2293.  
  2294.  
  2295.           clX, Licensing Agreement.                                 page 37
  2296.  
  2297.  
  2298.  
  2299.                                   clX Registration,
  2300.                                 Word Perfect Version.
  2301.  
  2302.                                    Schedule of Fees
  2303.  
  2304.                                         -oOo-
  2305.  
  2306.  
  2307.  
  2308.           Note: Prices are in US dollars.
  2309.  
  2310.  
  2311.                    No     License 
  2312.                   Users     Fee
  2313.                   =====   =======
  2314.  
  2315.                      1     $125
  2316.                      2     $234
  2317.                      3     $338
  2318.                      4     $436
  2319.                      5     $530
  2320.                      6     $618
  2321.                      7     $701
  2322.                      8     $780
  2323.                      9     $855
  2324.                     10     $925
  2325.                     11     $991
  2326.                     12   $1,053
  2327.                     13   $1,110
  2328.                     14   $1,164
  2329.                     15   $1,213
  2330.                     16   $1,259
  2331.                     17   $1,301
  2332.                     18   $1,339
  2333.                     19   $1,373
  2334.                     20   $1,403
  2335.                     21   $1,430
  2336.                     22   $1,453
  2337.                     23   $1,473
  2338.                     24   $1,489
  2339.                     25+  $1,500
  2340.  
  2341.  
  2342.                The price for 25 or more users is $US 1,500.
  2343.  
  2344.  
  2345.  
  2346.  
  2347.  
  2348.                                             Copyright 1992, Andrew McBurnie
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354.           clX, Licensing Agreement.                         Technical Appendix                                                                    page 38
  2355.  
  2356.  
  2357.                                   LICENSEE AGREEMENT
  2358.                                   ==================
  2359.  
  2360.           I have read, understood and agree to all the Terms and Conditions
  2361.           of this License Agreement as attached:
  2362.  
  2363.           Licensee Signature  .........................................
  2364.  
  2365.           Name and Title      .........................................
  2366.  
  2367.           Date                .........................................
  2368.  
  2369.  
  2370.                                      LICENSE FEES
  2371.  
  2372.           (The license fee is as indicated in the schedule of fees above)
  2373.  
  2374.  
  2375.           NUMBER OF USERS :      .........
  2376.  
  2377.           TOTAL LICENSE FEE : $US......... 
  2378.           (Read off price against number of users in the Schedule above.)
  2379.  
  2380.  
  2381.           NOTE: Make cheques payable to :  "Generic Software Pty Ltd".
  2382.                 Send cheques and signed agreement to :
  2383.  
  2384.                               Generic Software Pty Ltd,
  2385.                               26 Chalder Street,
  2386.                               Newtown, NSW, 2042,
  2387.                               AUSTRALIA.
  2388.  
  2389.  
  2390.                                  TERMS and CONDITIONS
  2391.                                  ====================
  2392.  
  2393.           THIS LICENCE  AGREEMENT IS ENTERED INTO  BETWEEN GENERIC SOFTWARE
  2394.           PTY  LTD, ACN  054 834  196, A  COMPANY REGISTERED  IN AUSTRALIA,
  2395.           (HEREIN REFERRED TO  AS "LICENSOR") OF THE ONE PART  AND YOU, THE
  2396.           LICENSEE, ON THE OTHER.
  2397.  
  2398.           PLEASE  READ THIS  DOCUMENT CAREFULLY  BEFORE USING  THE LICENSOR
  2399.           SOFTWARE THE SUBJECT OF THIS LICENSE.
  2400.  
  2401.           BY USING THE SOFTWARE, INCLUDING FOR TRIAL PURPOSES, YOU AGREE TO
  2402.           BECOME BOUND BY THE  TERMS OF THIS AGREEMENT, WHICH  INCLUDES THE
  2403.           SOFTWARE LICENSE AND DISCLAIMER OF WARRANTY.
  2404.  
  2405.  
  2406.  
  2407.           Copyright 1992, Andrew McBurnie
  2408.  
  2409.  
  2410.  
  2411.  
  2412.  
  2413.           clX, Licensing Agreement.                                 page 39
  2414.  
  2415.           THIS  DOCUMENT CONSTITUTES A LICENSE  TO USE THE  SOFTWARE ON THE
  2416.           TERMS AND CONDITIONS APPEARING BELOW.
  2417.  
  2418.           The  computer  program referred  to  as  "clX,  The Clause  Cross
  2419.           Referencer,  (Word Perfect  version)", and  related documentation
  2420.           and materials (herein collectively referred to as "the Software")
  2421.           are  licensed, not sold,  to you for  use only upon  the terms of
  2422.           this  license, and  Licensor  reserves all  rights not  expressly
  2423.           granted to you.  
  2424.  
  2425.           1.   License.
  2426.  
  2427.                (a)  This  License allows the Software  to be used  by up to
  2428.                     the number  of users in your  organisation indicated at
  2429.                     "NUMBER OF USERS", above.
  2430.  
  2431.                (b)  If at  any time  you wish  to have  more  users of  the
  2432.                     software than indicated at  "NUMBER OF USERS", you must
  2433.                     pay  Licensor an additional  amount for  the additional
  2434.                     numbers  of users,  this  additional  amount being  the
  2435.                     difference between  the cost for the  number of current
  2436.                     users and the cost for  the new number of users  as set
  2437.                     under "clX Registration, Schedule of Fees".
  2438.  
  2439.                (c)  No monies are refundable by  Licensor if you choose  to
  2440.                     decrease the number of users.
  2441.  
  2442.                (d)  You are granted a  limited license to distribute copies
  2443.                     of  the Software for the trial use of others subject to
  2444.                     the conditions described below.
  2445.  
  2446.                     (i)       The  PC  DOS  files,   clx.exe,  clxovl1.exe,
  2447.                               clxovl2.exe,     clxovl3.exe,     clxman.txt,
  2448.                               clxintro.txt,    clxregis.txt,    clxupd.txt,
  2449.                               clxplans.txt and readme.txt, which constitute
  2450.                               the Software, must be distributed together.
  2451.               
  2452.                     (ii)      You may charge a nominal fee for distribution
  2453.                               of  the  Software.    The  recipient  of  the
  2454.                               Software  must be informed,  in advance, that
  2455.                               any  such nominal  fee  paid  to acquire  the
  2456.                               Software  does not  relieve the  recipient of
  2457.                               their  obligation to  purchase a  license for
  2458.                               the   Software  if  the  recipient  uses  the
  2459.                               Software.
  2460.  
  2461.                     (iii)     the  Software may only  be bundled with other
  2462.                               products   with   written   permission   from
  2463.                               Licensor.
  2464.  
  2465.  
  2466.                                             Copyright 1992, Andrew McBurnie
  2467.  
  2468.  
  2469.  
  2470.  
  2471.  
  2472.           clX, Licensing Agreement.                         Technical Appendix                                                                    page 40
  2473.  
  2474.                     (f)  You may also copy the Software for distribution to
  2475.                          the number of licensed users in your organisation,
  2476.                          if that is necessary, and also for the purposes of
  2477.                          backup.
  2478.  
  2479.           2.   Restrictions.
  2480.  
  2481.                (a)  YOU  MAY  NOT  MODIFY,   ADAPT,  TRANSLATE,  OR  CREATE
  2482.                     DERIVATIVE WORKS  BASED UPON  THE SOFTWARE OR  ANY PART
  2483.                     THEREOF.
  2484.  
  2485.                (b)  The Software contains trade secrets and to protect them
  2486.                     you may not decompile, reverse engineer, disassemble or
  2487.                     otherwise   transform   the  Software   to   a  humanly
  2488.                     perceivable form.   You agree not  to divulge, directly
  2489.                     or indirectly, any such trade secrets to any person.
  2490.  
  2491.           3.   Termination.
  2492.  
  2493.                This  License is  effective until  terminated.   The License
  2494.                will terminate automatically without notice from Licensor if
  2495.                you  fail to comply with any provision of this License. Upon
  2496.                termination of this license for any reason:
  2497.  
  2498.                (a)  you shall have no right  to refund of the whole or  any
  2499.                     part of the license fees or other amounts paid for this
  2500.                     license and the Software  licensed hereunder (except in
  2501.                     the circumstances and expressly as provided in  Section
  2502.                     5 below); and
  2503.  
  2504.                (b)  you shall  continue to  be bound by  the provisions  of
  2505.                     Section 2 above.
  2506.  
  2507.                Termination  shall  be  without   prejudice  to  any  rights
  2508.                Licensor may have as a result of breach of this Agreement.
  2509.  
  2510.           4.   Limited Warranty.
  2511.  
  2512.                (a)  Licensor warrants  the media  in which the  software is
  2513.                     recorded  and supplied to  you as free  from defects in
  2514.                     materials and faulty workmanship under normal use for a
  2515.                     period of ninety  (90) days from the  date of delivery.
  2516.                     During  this warranty  period,  Licensor  will, at  its
  2517.                     option,  repair or  replace, free of  charge, defective
  2518.                     media upon which the software has been supplied (and if
  2519.                     necessary restore the Software thereon).
  2520.  
  2521.                (b)  For twelve months from the date of license fee receipt,
  2522.                     Licensor will  examine copies of  documents supplied in
  2523.                     Word  Perfect 5.1  or 5.2  format from  Licensee, which
  2524.  
  2525.           Copyright 1992, Andrew McBurnie
  2526.  
  2527.  
  2528.  
  2529.  
  2530.  
  2531.           clX, Licensing Agreement.                                 page 41
  2532.  
  2533.                     Licensee  asserts  is  processed  incorrectly   by  the
  2534.                     software.   Licensor will  make  reasonable efforts  to
  2535.                     identify the  cause of the  problem, and  supply a  new
  2536.                     version  of clX if  this is practicable.   Licensor may
  2537.                     decide,  and has  sole  discretion to  decide, that  no
  2538.                     resolution  of  the  problem   is  possible,  and  such
  2539.                     decision by Licensor will be final.  
  2540.  
  2541.                (c)  LICENSEE  UNDERSTANDS   AND  AGREES  THAT   BECAUSE  OF
  2542.                     AMBIGUITIES AND IRREGULARITIES IN THE ENGLISH LANGUAGE,
  2543.                     AND IN THE RANGE  OF DRAFTING STYLES WHICH MAY  BE USED
  2544.                     BY AUTHORS, THE EXTRACTION OF ALL RELEVANT DATA  BY THE
  2545.                     SOFTWARE  IS NOT  GUARANTEED TO  BE EITHER  COMPLETE OR
  2546.                     ACCURATE.  
  2547.  
  2548.           5.   Disclaimer of Warranty, Limitation of Remedies.
  2549.  
  2550.                TO  THE  FULL  EXTENT  PERMITTED  BY  LAW,  LICENSOR  HEREBY
  2551.                EXCLUDES  ALL CONDITIONS AND  WARRANTIES, WHETHER IMPOSED BY
  2552.                STATUTE OR BY OPERATION  OF LAW OR OTHERWISE,  NOT EXPRESSLY
  2553.                SET  OUT HEREIN.  THE  SOFTWARE IS PROVIDED  "AS IS" WITHOUT
  2554.                WARRANTY  OF ANY KIND EXCEPT AS PROVIDED IN SECTION 4 ABOVE.
  2555.                LICENSOR   DOES   NOT  WARRANT,   GUARANTEE   OR  MAKE   ANY
  2556.                REPRESENTATIONS  REGARDING THE  USE, OR  THE RESULTS  OF THE
  2557.                USE,  OF  THE  SOFTWARE  WITH RESPECT  TO  ITS  CORRECTNESS,
  2558.                ACCURACY, RELIABILITY, CURRENTNESS OR OTHERWISE.  THE ENTIRE
  2559.                RISK  AS TO THE RESULTS  AND PERFORMANCE OF  THE SOFTWARE IS
  2560.                ASSUMED BY YOU.  
  2561.  
  2562.                EXCEPT AS SPECIFICALLY SET FORTH IN THIS SECTION 5, LICENSOR
  2563.                MAKES  NO  EXPRESS  OR  IMPLIED   WARRANTIES  OR  CONDITIONS
  2564.                INCLUDING,   WITHOUT   LIMITATION,    THE   WARRANTIES    OF
  2565.                MERCHANTABILITY  OR FITNESS FOR  A PARTICULAR  PURPOSE, WITH
  2566.                RESPECT  TO THE SOFTWARE.  NO ORAL OR WRITTEN INFORMATION OR
  2567.                ADVICE GIVEN BY LICENSOR, ITS DEALERS, DISTRIBUTORS,  AGENTS
  2568.                OR  EMPLOYEES SHALL CREATE A WARRANTY OR IN ANY WAY INCREASE
  2569.                THE SCOPE OF THIS WARRANTY, AND YOU MAY NOT RELY ON ANY SUCH
  2570.                INFORMATION OR ADVICE.
  2571.  
  2572.                IMPORTANT  NOTE:  Nothing  in this Agreement  is intended or
  2573.                shall be  construed as excluding or  modifying any statutory
  2574.                rights,  warranties or  conditions  which are  applicable to
  2575.                this Agreement or the Software supplied hereunder, and which
  2576.                by  virtue  of any  national  or state  Fair  trading, Trade
  2577.                Practices or other consumer  legislation may not be modified
  2578.                or  excluded.  If  permitted by  such  legislation, however,
  2579.                Licensor's liability for any breach of  any such warranty or
  2580.                condition shall be and is hereby limited to either:
  2581.  
  2582.  
  2583.  
  2584.                                             Copyright 1992, Andrew McBurnie
  2585.  
  2586.  
  2587.  
  2588.  
  2589.  
  2590.           clX, Licensing Agreement.                         Technical Appendix                                                                    page 42
  2591.  
  2592.                (a)  the  supply  of  such  part of  the  Software  licensed
  2593.                     hereunder again; or
  2594.  
  2595.                (b)  the  correction of any defect  in any such  part of the
  2596.                     Software licensed hereunder
  2597.  
  2598.                as Licensor  at  its sole  discretion  may determine  to  be
  2599.                necessary to correct the said breach.
  2600.  
  2601.                EXCEPT  AS SET  OUT IN  THIS  SECTION 5,  IN NO  EVENT SHALL
  2602.                LICENSOR BE LIABLE FOR  ANY SPECIAL, INCIDENTAL, INDIRECT OR
  2603.                CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION, DAMAGES
  2604.                FOR  LOSS OF  BUSINESS PROFITS,  BUSINESS INTERRUPTION,  AND
  2605.                LOSS OF BUSINESS INFORMATION  OR COMPUTER PROGRAMS), EVEN IF
  2606.                LICENSOR OR ANY LICENSOR  REPRESENTATIVE HAS BEEN ADVISED OF
  2607.                THE POSSIBILITY OF SUCH DAMAGES.
  2608.  
  2609.                Except as  expressly set out  in this section  5, Licensor's
  2610.                maximum  liability for damages  arising under this Agreement
  2611.                shall be  limited to the  license fees paid by  you for that
  2612.                part of  the Software  supplied by Licensor  hereunder which
  2613.                caused the damages or that  is the subject matter of,  or is
  2614.                directly related to, the cause of the action.
  2615.  
  2616.           6.   General.
  2617.  
  2618.                This Agreement will be construed under the laws of the state
  2619.                of  New South  Wales.   This Agreement  contains the  entire
  2620.                Agreement  between the  parties hereto  with respect  to the
  2621.                subject matter hereof,  and supersedes all  prior agreements
  2622.                and/or understandings  (oral or written).   Failure or delay
  2623.                by Licensor in enforcing any right or provision hereof shall
  2624.                not  be  deemed a  waiver of  such  provision or  right with
  2625.                respect to the  instant or  any subsequent breach.   If  any
  2626.                provision  of this  Agreement shall  be held  by a  court or
  2627.                competent jurisdiction to be contrary to law, that provision
  2628.                will be enforced to the  maximum extent permissible, and the
  2629.                remaining provisions  of this Agreement will  remain in full
  2630.                force and effect.
  2631.  
  2632.  
  2633.  
  2634.  
  2635.  
  2636.  
  2637.  
  2638.  
  2639.  
  2640.  
  2641.  
  2642.  
  2643.           Copyright 1992, Andrew McBurnie
  2644.  
  2645.  
  2646.  
  2647.  
  2648.  
  2649.                                                                     page 43
  2650.  
  2651.  
  2652.                                         INDEX
  2653.  
  2654.           Annexures/attachments
  2655.                processing of  26
  2656.                specifying string  of characters  for clX  to recognise
  2657.                     13
  2658.           browse  7
  2659.                clX report  7
  2660.           browser  7
  2661.           clause format  9-11, 13, 16, 17, 29, 30, 33, 10, 16, 17
  2662.           Clause number
  2663.                ambiguity in identification  25
  2664.                Identification of  25
  2665.                specify format  16
  2666.                specify maximum  15
  2667.                spurious error messages if wrong format specified  17
  2668.                spurious errors messages if multiple formats used  17
  2669.                subclause numbers  25, 26
  2670.                unable to distinguish from numbered lists  25
  2671.           Clause number references  1
  2672.                limitation on error detection  26
  2673.           clause numbering  2
  2674.           clauses cross reference  11
  2675.           control panel  2, 25, 30, 2, 32
  2676.                parameter file  9
  2677.           cross reference  1, 3, 6, 7, 9, 11, 14, 21, 26, 33, 34
  2678.           Cross reference report  11, 33
  2679.           Defaults settings  9
  2680.           Definitions
  2681.                primary identifying features  25
  2682.                quoted references not recognised  25
  2683.                Specify Definition section number  14
  2684.           directory  6, 9, 32, 33
  2685.           Document attachments
  2686.                attachments  13
  2687.           drafting   1, 2, 5, 7, 9,  11, 13, 14, 16,  17, 20, 25, page
  2688.                     35, page 41
  2689.           drafting style  2, 5, 7, 9, 13, 16, 17, 25, page 35, 2
  2690.           Help screen  7
  2691.           Interpretive provisions  14
  2692.           main menu  5-7, 9, 13, 19, 21, 23, 28, 5, 9
  2693.           Markup characters
  2694.                Ignoring  20
  2695.           maximum clause number  9, 13, 15, 16, 15
  2696.           memory  6, 31, 34
  2697.           Menu item
  2698.                items which must be set up  9
  2699.           natural language  1, 2
  2700.           Natural language processing technology  1
  2701.  
  2702.                                             Copyright 1992, Andrew McBurnie
  2703.  
  2704.  
  2705.  
  2706.  
  2707.  
  2708.                                                                     page 44
  2709.  
  2710.           Observations and Errors  11, 12, 21, 26-28, 11
  2711.                Producing only  21
  2712.           Observations and Errors Report
  2713.                attachments noted  26
  2714.           Original settings  9
  2715.           Page dimensions
  2716.                Report  21, 22
  2717.           parameter  9, 30, 32
  2718.           parameters  9, 30, 33
  2719.           path name  6
  2720.           PC DOS  6, page 35, page 39
  2721.           precedent documents  9
  2722.           printer  7, 21, 22, 33
  2723.           printing  7, 21, 22
  2724.           QEMM  34
  2725.           Quote Marks
  2726.                Specify type of  14
  2727.           Report  7
  2728.           Report page
  2729.                layout, possible distortion of  33
  2730.           Reports  11
  2731.           Systems administrator  5, 7, 22, 30-32, 5, 7, 32
  2732.  
  2733.            
  2734.  
  2735.  
  2736.  
  2737.  
  2738.  
  2739.  
  2740.  
  2741.  
  2742.  
  2743.  
  2744.  
  2745.  
  2746.  
  2747.  
  2748.  
  2749.  
  2750.  
  2751.  
  2752.  
  2753.  
  2754.  
  2755.  
  2756.  
  2757.  
  2758.  
  2759.  
  2760.  
  2761.           Copyright 1992, Andrew McBurnie